/**
* Copyright 2017 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import { jsonEval, stringify } from '@firebase/util';
/**
* Wraps a DOM Storage object and:
* - automatically encode objects as JSON strings before storing them to allow us to store arbitrary types.
* - prefixes names with "firebase:" to avoid collisions with app data.
*
* We automatically (see storage.js) create two such wrappers, one for sessionStorage,
* and one for localStorage.
*
* @constructor
*/
export class DOMStorageWrapper {
// Use a prefix to avoid collisions with other stuff saved by the app.
private prefix_ = 'firebase:';
/**
* @param {Storage} domStorage_ The underlying storage object (e.g. localStorage or sessionStorage)
*/
constructor(private domStorage_: Storage) {}
/**
* @param {string} key The key to save the value under
* @param {?Object} value The value being stored, or null to remove the key.
*/
set(key: string, value: any | null) {
Iif (value == null) {
this.domStorage_.removeItem(this.prefixedName_(key));
} else {
this.domStorage_.setItem(this.prefixedName_(key), stringify(value));
}
}
/**
* @param {string} key
* @return {*} The value that was stored under this key, or null
*/
get(key: string): any {
const storedVal = this.domStorage_.getItem(this.prefixedName_(key));
if (storedVal == null) {
return null;
} else {
return jsonEval(storedVal);
}
}
/**
* @param {string} key
*/
remove(key: string) {
this.domStorage_.removeItem(this.prefixedName_(key));
}
isInMemoryStorage: boolean;
/**
* @param {string} name
* @return {string}
*/
prefixedName_(name: string): string {
return this.prefix_ + name;
}
toString(): string {
return this.domStorage_.toString();
}
}
|